home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / math / yplot-0.000 / yplot-0 / yplot-0.9 / README < prev    next >
Text File  |  1996-06-04  |  4KB  |  89 lines
  1. This is the README file for YPLOT, a Yorick interface to PLPlot.
  2.  
  3. PREAMBLE
  4. -------------------------------------------------------------------------
  5. YPLOT is meant to be a useful tool in creating scientific plots of both
  6. draft and publication quality very quickly and efficiently.
  7. That said, it should be realised that most of this usefulness comes from
  8. Yorick and PLPlot, so thanks to their respective creators and maintainers.
  9. Most of what YPLOT can do is due to the fact that David Munroe wrote Yorick
  10. to be extensible by linking external object files to the Yorick interpreter.
  11. Thanks!
  12.  
  13. YPLOT facilities
  14. -------------------------------------------------------------------------
  15. At this stage YPLOT implements a subset of the (extensive) capabilities of
  16. the PLPlot library. That said, most of the high level API is avialible
  17. directly to the user, with extra some extra functions added for reading data
  18. from files. More functions can eassily be added on request or contribution.
  19.  
  20. So, YPLOT can do the following in the hands of even an inexperienced user:
  21. o Access to all the capabilities of Yorick. Do all your data generation,
  22.   interpretation and plotting from one package.
  23. o Linear plots
  24. o Log-log plots, with any variations of log and linear axes possible
  25. o 3D surface and mesh plots (there is a difference, really ;-)
  26. o 3D line and scatter 
  27. o Grid lines
  28. o Lots of symbols and stroked fonts to choose from, all scalable
  29. o Full control over boxes drawn, captions, fonts and placement of labels
  30. o Speed: A YPLOT plot finishes in about 3 times that of the corresponding
  31.   compiled C version. Huh? Doesn't sound very fast, until you factor in the
  32.   compiling time and development time (which can be VERY long if your C is
  33.   not quite up to scratch. Like mine :-)
  34. o Fast development due to the the interpreted nature of YPLOT
  35. o Lots of output devices, including X11, Postscript, Laserjet printers, and
  36.   PLPlot metafiles for later rendering.
  37. o PLUS: a tutorial and reference manual that demonstrates most of YPLOT's
  38.   capabilities with explanations every step of the way!
  39.  
  40. Note on Landscape and Portrait plotting
  41. ----------------------------------------------------------------------------
  42. PLPlot was designed to plot in landscape mode. Period. (OK, so you can get
  43. it to plot in Portrait mode, but this aspect ratio is still that of a
  44. Landscape plot)
  45.  
  46. For that reason, I include my own hacks of the PLPlot drivers ps.c and
  47. ljiip.c to enable you to compile PLPlot to produce Portrait Postscript and
  48. Laserjet files. These files should be copied in the directory
  49. ${PLPlot_top}/tmp
  50. where you untarred the PLPlot distribution.
  51.  
  52. DEMOS
  53. ----------------------------------------------------------------------------
  54. The doc subdirectory contains a few examples to show off YPLOT.
  55. After installing, run these with eg.
  56. yplot -batch demo1.i
  57.  
  58. Near the top of each of these files is a driver specification, of the form 
  59. "xwin" of "ps" for the X11 of Postscript drivers. Change this to one of the
  60. PLPlot devices according to what is availible to you.
  61.  
  62. Bugs and patches and support
  63. ---------------------------------------------------------------------------
  64. "Correct them, send them, and don't expect any" ;-)
  65.  
  66. Seriously:
  67. If you find any serious bugs, do the following:
  68. o Try really hard to find out if it isn't your own fault.
  69. o If you are able, try and correct the problem in either read.c, pplot.c or
  70.   yplot.i or the Makefile (that's my only contribution actually)
  71. o Send me a discription of the problem and any diffs (see man diff) you may
  72.   come up with.
  73. o I will try my best to solve the problem or incorporate your fix.
  74.  
  75. That said, YPLOT has been in daily use for some time at the SRU without any
  76. and is considered quite stable.
  77.  
  78. If you would like to do any work on extending YPLOT, go ahead make my month!
  79. Look at the files read.c, pplot.c and yplot.i for examples. It really isn't
  80. very complicated, even I could understand it...
  81.  
  82. Please...
  83. ---------------------------------------------------------------------------
  84. If you find YPLOT useful, please drop me an e-mail. It helps justify the
  85. time I spent developing YPLOT when I should have been doing serious
  86. research.
  87.  
  88. C. Steenberg (conrad@fskcds.puk.ac.za)
  89. 4/6/96